<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python documentation Index' />
<link rel="first" href="lib.html" title='Python library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="module-shelve.html" />
<link rel="prev" href="module-cPickle.html" />
<link rel="parent" href="persistence.html" />
<link rel="next" href="module-shelve.html" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name='aesop' content='information' />
<title>13.3 copy_reg -- Register pickle support functions</title>
</head>
<body>
<div class="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="13.2 cpickle  "
  href="module-cPickle.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="13. data Persistence"
  href="persistence.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="13.4 shelve  "
  href="module-shelve.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-cPickle.html">13.2 cPickle  </a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="persistence.html">13. Data Persistence</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-shelve.html">13.4 shelve  </a>
</div>
<hr /></div>
</div>
<!--End of Navigation Panel-->

<h1><a name="SECTION0015300000000000000000">
13.3 <tt class="module">copy_reg</tt> --
         Register <tt class="module">pickle</tt> support functions</a>
</h1>

<p>
<a name="module-copyreg"></a>

<p>
The <tt class="module">copy_reg</tt> module provides support for the
<tt class="module"><a href="module-pickle.html">pickle</a></tt><a id='l2h-2483' xml:id='l2h-2483'></a> and
<tt class="module"><a href="module-cPickle.html">cPickle</a></tt><a id='l2h-2484' xml:id='l2h-2484'></a> modules.  The
<tt class="module"><a href="module-copy.html">copy</a></tt><a id='l2h-2485' xml:id='l2h-2485'></a> module is likely to use this in the
future as well.  It provides configuration information about object
constructors which are not classes.  Such constructors may be factory
functions or class instances.

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2481' xml:id='l2h-2481' class="function">constructor</tt></b>(</nobr></td>
  <td><var>object</var>)</td></tr></table></dt>
<dd>
  Declares <var>object</var> to be a valid constructor.  If <var>object</var> is
  not callable (and hence not valid as a constructor), raises
  <tt class="exception">TypeError</tt>.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2482' xml:id='l2h-2482' class="function">pickle</tt></b>(</nobr></td>
  <td><var>type, function</var><big>[</big><var>, constructor</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
  Declares that <var>function</var> should be used as a ``reduction''
  function for objects of type <var>type</var>; <var>type</var> must not be a
  ``classic'' class object.  (Classic classes are handled differently;
  see the documentation for the <tt class="module"><a href="module-pickle.html">pickle</a></tt> module for
  details.)  <var>function</var> should return either a string or a tuple
  containing two or three elements.

<p>
The optional <var>constructor</var> parameter, if provided, is a
  callable object which can be used to reconstruct the object when
  called with the tuple of arguments returned by <var>function</var> at
  pickling time.  <tt class="exception">TypeError</tt> will be raised if
  <var>object</var> is a class or <var>constructor</var> is not callable.

<p>
See the <tt class="module"><a href="module-pickle.html">pickle</a></tt> module for more
  details on the interface expected of <var>function</var> and
  <var>constructor</var>.
</dl>

<div class="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="13.2 cpickle  "
  href="module-cPickle.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="13. data Persistence"
  href="persistence.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="13.4 shelve  "
  href="module-shelve.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-cPickle.html">13.2 cPickle  </a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="persistence.html">13. Data Persistence</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-shelve.html">13.4 shelve  </a>
</div>
</div>
<hr />
<span class="release-info">Release 2.5.1, documentation updated on 18th April, 2007.</span>
</div>
<!--End of Navigation Panel-->
<address>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</address>
</body>
</html>
